<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>CKFinderAPI - CKFinder 2 JavaScript API Documentation</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 230px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 260px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px;
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}

		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
	<h1>CKFinder 2 JavaScript API Documentation</h1>
	<hr />
</div>

		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div>
	<a href="../index.html">Code Index</a>
</div>
<hr />
<h2>Namespaces</h2>
<ul class="classList">
	
		
	
		
			<li>
				<a href="../symbols/CKFinder.html">CKFinder</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ajax.html">CKFinder.ajax</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.config.html">CKFinder.config</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dataTypes.html">CKFinder.dataTypes</a>
			</li>
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
			<li>
				<a href="../symbols/CKFinder.dom.html">CKFinder.dom</a>
			</li>
		
	
		
	
		
	
		
	
		
	
		
			<li>
				<a href="../symbols/CKFinder.env.html">CKFinder.env</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.tools.html">CKFinder.tools</a>
			</li>
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
	
		
			<li>
				<a href="../symbols/CKFinderAPI.html">CKFinderAPI</a>
			</li>
		
	
</ul>
<h2>Classes</h2>
<ul class="classList">
	
		
	
		
	
		
	
		
	
		
	
		
			<li>
				<a href="../symbols/CKFinder.dataTypes.Acl.html">CKFinder.dataTypes.Acl</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dataTypes.BasketFolder.html">CKFinder.dataTypes.BasketFolder</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dataTypes.Connector.html">CKFinder.dataTypes.Connector</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dataTypes.File.html">CKFinder.dataTypes.File</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dataTypes.Folder.html">CKFinder.dataTypes.Folder</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dataTypes.ResourceType.html">CKFinder.dataTypes.ResourceType</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.html">CKFinder.dialog</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.html">CKFinder.dialog.definition</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.button.html">CKFinder.dialog.definition.button</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.checkbox.html">CKFinder.dialog.definition.checkbox</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.content.html">CKFinder.dialog.definition.content</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.contentObject.html">CKFinder.dialog.definition.contentObject</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.file.html">CKFinder.dialog.definition.file</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.fileButton.html">CKFinder.dialog.definition.fileButton</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.hbox.html">CKFinder.dialog.definition.hbox</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.html.html">CKFinder.dialog.definition.html</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.radio.html">CKFinder.dialog.definition.radio</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.select.html">CKFinder.dialog.definition.select</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.textarea.html">CKFinder.dialog.definition.textarea</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.textInput.html">CKFinder.dialog.definition.textInput</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.uiElement.html">CKFinder.dialog.definition.uiElement</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definition.vbox.html">CKFinder.dialog.definition.vbox</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dialog.definitionObject.html">CKFinder.dialog.definitionObject</a>
			</li>
		
	
		
	
		
			<li>
				<a href="../symbols/CKFinder.dom.document.html">CKFinder.dom.document</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dom.domObject.html">CKFinder.dom.domObject</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dom.element.html">CKFinder.dom.element</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.dom.node.html">CKFinder.dom.node</a>
			</li>
		
	
		
	
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.button.html">CKFinder.ui.dialog.button</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.checkbox.html">CKFinder.ui.dialog.checkbox</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.file.html">CKFinder.ui.dialog.file</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.fileButton.html">CKFinder.ui.dialog.fileButton</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.hbox.html">CKFinder.ui.dialog.hbox</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.html.html">CKFinder.ui.dialog.html</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.labeledElement.html">CKFinder.ui.dialog.labeledElement</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.radio.html">CKFinder.ui.dialog.radio</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.select.html">CKFinder.ui.dialog.select</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.textarea.html">CKFinder.ui.dialog.textarea</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.textInput.html">CKFinder.ui.dialog.textInput</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.uiElement.html">CKFinder.ui.dialog.uiElement</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.ui.dialog.vbox.html">CKFinder.ui.dialog.vbox</a>
			</li>
		
	
		
			<li>
				<a href="../symbols/CKFinder.xml.html">CKFinder.xml</a>
			</li>
		
	
		
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Namespace CKFinderAPI
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
				
			
				
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class CKFinderAPI.">
				<caption>Namespace Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/CKFinderAPI.html#constructor">CKFinderAPI</a></b>
							</div>
							<div class="description">The CKFinder API class.</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			

				
				

				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class CKFinderAPI.">
					<caption>Field Summary</caption>
					<thead>
						<tr>
							<th scope="col">Field Attributes</th>
							<th scope="col">Field Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								CKFinderAPI.<b><a href="../symbols/CKFinderAPI.html#.id">id</a></b>
								</div>
								<div class="description">The ID of the CKFinder instance.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								CKFinderAPI.<b><a href="../symbols/CKFinderAPI.html#.inFrame">inFrame</a></b>
								</div>
								<div class="description">Determines if CKFinder is running in a frame via URL.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								CKFinderAPI.<b><a href="../symbols/CKFinderAPI.html#.inIframe">inIframe</a></b>
								</div>
								<div class="description">Determines if CKFinder is running in an iframe via URL.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								CKFinderAPI.<b><a href="../symbols/CKFinderAPI.html#.inPopup">inPopup</a></b>
								</div>
								<div class="description">Determines if CKFinder is running in a popup.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								CKFinderAPI.<b><a href="../symbols/CKFinderAPI.html#.inUrlPopup">inUrlPopup</a></b>
								</div>
								<div class="description">Determines if CKFinder is running in a popup.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/CKFinderAPI.html#_">_</a></b>
								</div>
								<div class="description">Private scope</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class CKFinderAPI.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#addFileContextMenuOption">addFileContextMenuOption</a></b>(optionDefinition, clickCallback, decisionCallback)
								</div>
								<div class="description">Adds a new option to file context menu.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#addFolderContextMenuOption">addFolderContextMenuOption</a></b>(optionDefinition, clickCallback, decisionCallback)
								</div>
								<div class="description">Adds a new option to folder context menu.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#addFolderDropMenuOption">addFolderDropMenuOption</a></b>(optionDefinition, clickCallback, decisionCallback)
								</div>
								<div class="description">Adds a new option to folder drop menu - the one that opens when files are dropped into a folder.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#addTool">addTool</a></b>(markup)
								</div>
								<div class="description">Adds a tool space into the sidebar.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#addToolPanel">addToolPanel</a></b>(markup)
								</div>
								<div class="description">Adds a tool panel into the sidebar.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#closePopup">closePopup</a></b>()
								</div>
								<div class="description">Closes a popup window containing CKFinder.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#destroy">destroy</a></b>(callback)
								</div>
								<div class="description">Destroys the instance.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#disableFileContextMenuOption">disableFileContextMenuOption</a></b>(option, addedUsingApi)
								</div>
								<div class="description">Permanently disable specific file context menu option.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#disableFolderContextMenuOption">disableFolderContextMenuOption</a></b>(option, addedUsingApi)
								</div>
								<div class="description">Permanently disable specific folder context menu option.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#disableFolderDropMenuOption">disableFolderDropMenuOption</a></b>(option, addedUsingApi)
								</div>
								<div class="description">Permanently disable specific folder drop menu option.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#emptyBasket">emptyBasket</a></b>()
								</div>
								<div class="description">Removes all files from the Basket folder (not from the filesystem folder).</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#execCommand">execCommand</a></b>(name)
								</div>
								<div class="description"></div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#filterFiles">filterFiles</a></b>(lookup)
								</div>
								<div class="description">Filter the displayed files according to the specified string.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#getResourceType">getResourceType</a></b>(resourceTypeName)
								</div>
								<div class="description">Returns an object of resource type by name.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#getSelectedFile">getSelectedFile</a></b>()
								</div>
								<div class="description">Gets a selected file object.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#getSelectedFiles">getSelectedFiles</a></b>()
								</div>
								<div class="description">Gets an array of selected files.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#getSelectedFolder">getSelectedFolder</a></b>()
								</div>
								<div class="description">Gets a selected folder object.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#hideTool">hideTool</a></b>(id)
								</div>
								<div class="description">Hides a tool panel/space by its ID.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#openConfirmDialog">openConfirmDialog</a></b>(title, msg, okCallback)
								</div>
								<div class="description">Opens an equivalent of a confirm() dialog window.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#openDialog">openDialog</a></b>(dialogName, callback)
								</div>
								<div class="description">Loads and opens a registered dialog window.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#openFolder">openFolder</a></b>(resourceType, path)
								</div>
								<div class="description">Opens a directory.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#openInputDialog">openInputDialog</a></b>(title, msg, value, okCallback)
								</div>
								<div class="description">Opens an equivalent of a prompt() dialog window.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#openMsgDialog">openMsgDialog</a></b>(title, msg)
								</div>
								<div class="description">Opens an equivalent of an alert() dialog window.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#openSkippedFilesDialog">openSkippedFilesDialog</a></b>(title, files, msg, okCallback)
								</div>
								<div class="description">Opens a message dialog with a list of skipped files.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#refreshOpenedFolder">refreshOpenedFolder</a></b>()
								</div>
								<div class="description">Refreshes the currently visible folder inside the files view.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#removeTool">removeTool</a></b>(id)
								</div>
								<div class="description">Removes a tool panel/space by its ID.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#replaceUploadForm">replaceUploadForm</a></b>(html, onShow, showFocusIndicator, priority)
								</div>
								<div class="description">Replaces the default upload form with custom HTML code.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#resizeFormPanel">resizeFormPanel</a></b>(height)
								</div>
								<div class="description"></div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#selectFile">selectFile</a></b>(fileToSelect)
								</div>
								<div class="description"></div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#setUiColor">setUiColor</a></b>(string)
								</div>
								<div class="description">Sets the main color of the UI.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKFinderAPI.html#showTool">showTool</a></b>(id)
								</div>
								<div class="description">Shows a tool panel/space by its ID.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			

<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Namespace Detail
				</div>
				
				<div class="fixedFont" style="float:left">
						<b>CKFinderAPI</b>
				</div>

				<div style="float:right">
					<span class="heading">Since:</span>
						
							2.0
						
				</div>
				<div style="clear:both"></div>
				
				<div class="description">
					The CKFinder API class. Contains methods that can be used to interact with CKFinder and extend CKFinder functionality.The API object contains instance-specific information, like currently selected file.<div style="padding:10px;margin:10px;border:1px #000 solid;background:#E0E0E0">Note: The CKFinderAPI object is not directly accessible (CKFinderAPI is undefined).<br />The API object is returned by methods used to create CKFinder, like CKFinder.create,and is passed to selected callback functions, like <a href="../symbols/CKFinder.config.html#.callback">CKFinder.config.callback</a>.</div>
					
				</div>
				
				
				
					
				
				
				
				
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			
				<div class="sectionTitle">
					Field Detail
				</div>
				
					<a name=".id"> </a>
					<div class="fixedFont" style="float:left">&lt;static&gt; 
					
					<span class="light">{String}</span>
					<span class="light">CKFinderAPI.</span><b>id</b>
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						The ID of the CKFinder instance.
						
					</div>
					
					
					
						
					
					

						
						
						

					<hr />
				
					<a name=".inFrame"> </a>
					<div class="fixedFont" style="float:left">&lt;static&gt; 
					
					<span class="light">{Boolean}</span>
					<span class="light">CKFinderAPI.</span><b>inFrame</b>
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Determines if CKFinder is running in a frame via URL.
						
					</div>
					
					
					
						
					
					

						
						
						

					<hr />
				
					<a name=".inIframe"> </a>
					<div class="fixedFont" style="float:left">&lt;static&gt; 
					
					<span class="light">{Boolean}</span>
					<span class="light">CKFinderAPI.</span><b>inIframe</b>
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Determines if CKFinder is running in an iframe via URL.
						
					</div>
					
					
					
						
					
					

						
						
						

					<hr />
				
					<a name=".inPopup"> </a>
					<div class="fixedFont" style="float:left">&lt;static&gt; 
					
					<span class="light">{Boolean}</span>
					<span class="light">CKFinderAPI.</span><b>inPopup</b>
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Determines if CKFinder is running in a popup.
						
					</div>
					
					
					
						
					
					

						
						
						

					<hr />
				
					<a name=".inUrlPopup"> </a>
					<div class="fixedFont" style="float:left">&lt;static&gt; 
					
					<span class="light">{Boolean}</span>
					<span class="light">CKFinderAPI.</span><b>inUrlPopup</b>
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Determines if CKFinder is running in a popup.
						
					</div>
					
					
					
						
					
					

						
						
						

					<hr />
				
					<a name="_"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Object}</span>
					<b>_</b>
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Private scope
						
					</div>
					
					
					
						
					
					

						
						
						

					
				
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name="addFileContextMenuOption"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>addFileContextMenuOption</b>(optionDefinition, clickCallback, decisionCallback)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Adds a new option to file context menu.
						
					</div>
					
					
					
						
							<pre class="code">var menuItem = {	label : 'Show Name',	command : 'DisplayName'};api.addFileContextMenuOption( menuItem, function( api, file )	{		api.openMsgDialog( "", "The name of the selected file: " + file.name );	});</pre>
						
					
						
							<pre class="code">var menuItem = {	label : 'Show Name',	command : 'DisplayName'};api.addFileContextMenuOption( menuItem, function( api, file )	{		api.openMsgDialog( "", "The name of the selected file: " + file.name );	},	function (file)	{		// Disable for images.		if ( file.isImage() )			return -1;		return true;	});</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>optionDefinition</b>
									
								</dt>
								<dd>Definition of a context menu item.A context menu item consists of three properties:<ul><li>{String} label - Label displayed to the user.</li><li>{String} command - Command name (used later to refer to that context menu item).</li><li>{String} group (Optional) - Group of items to which an item should belong. Default is 'file1'. </li></ul></dd>
							
								<dt>
									<span class="light fixedFont">{Function}</span> <b>clickCallback</b>
									
								</dt>
								<dd>Callback to be called when user chooses the option.Two parameters are passed:<ul><li><a href="../symbols/CKFinderAPI.html">CKFinderAPI</a> CKFinder API object.</li><li><a href="../symbols/CKFinder.dataTypes.File.html">CKFinder.dataTypes.File</a> Currently selected file.</li></ul></dd>
							
								<dt>
									<span class="light fixedFont">{Function}</span> <b>decisionCallback</b>
									
								</dt>
								<dd>(Optional) Callback to be called before showing the context menu.One parameter is passed:<ul><li>Clicked file object <a href="../symbols/CKFinder.dataTypes.File.html">CKFinder.dataTypes.File</a></li></ul>'this' context refers to the <a href="../symbols/CKFinderAPI.html">CKFinderAPI</a> object.Accepted return values:<ul><li><code>true</code> Display item.</li><li><code>false</code> Hide item.</li><li><code>-1</code> Display inactive (disabled) item.</li></ul></dd>
							
							</dl>
						
						
						
						
						
						

					<hr />
				
					<a name="addFolderContextMenuOption"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>addFolderContextMenuOption</b>(optionDefinition, clickCallback, decisionCallback)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Adds a new option to folder context menu.
						
					</div>
					
					
					
						
							<pre class="code">var menuItem = {	label : 'Show Url',	command : 'DisplayUrl'};api.addFolderContextMenuOption( menuItem, function( api, folder )	{		api.openMsgDialog( "", "The URL of the selected folder: " + folder.getUrl() );	});</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>optionDefinition</b>
									
								</dt>
								<dd>Definition of a context menu item.A context menu item consists of three properties:<ul><li>{String} label - Label displayed to the user.</li><li>{String} command - Command name (used later to refer to that context menu item).</li><li>{String} group (Optional) - Group of items to which an item should belong. Default is 'folder1'. </li></ul></dd>
							
								<dt>
									<span class="light fixedFont">{Function}</span> <b>clickCallback</b>
									
								</dt>
								<dd>Callback to be called when the user chooses the option.Two parameters are passed:<ul><li><a href="../symbols/CKFinderAPI.html">CKFinderAPI</a> CKFinder API object.</li><li><a href="../symbols/CKFinder.dataTypes.Folder.html">CKFinder.dataTypes.Folder</a> Currently selected folder.</li></ul></dd>
							
								<dt>
									<span class="light fixedFont">{Function}</span> <b>decisionCallback</b>
									
								</dt>
								<dd>(Optional) Callback to be called before showing the context menu.One parameter is passed:<ul><li>Clicked folder object <a href="../symbols/CKFinder.dataTypes.Folder.html">CKFinder.dataTypes.Folder</a></li></ul>'this' context refers to the <a href="../symbols/CKFinderAPI.html">CKFinderAPI</a> object.Accepted return values:<ul><li><code>true</code> Display item.</li><li><code>false</code> Hide item.</li><li><code>-1</code> Display inactive (disabled) item.</li></ul></dd>
							
							</dl>
						
						
						
						
						
						

					<hr />
				
					<a name="addFolderDropMenuOption"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>addFolderDropMenuOption</b>(optionDefinition, clickCallback, decisionCallback)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.3
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Adds a new option to folder drop menu - the one that opens when files are dropped into a folder.
						
					</div>
					
					
						<pre class="code"><span style="color:red">NO EXAMPLE AVAILABLE</span></pre>
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>optionDefinition</b>
									
								</dt>
								<dd>Definition of a menu item.A menu item consists of two properties:<ul><li>{String} label - Label displayed to the user.</li><li>{String} command - Command name (used later to refer to that menu item).</li><li>{String} icon (Optional) - Path to the icon file. Set to false to disable the icon.</li></ul></dd>
							
								<dt>
									<span class="light fixedFont">{Function}</span> <b>clickCallback</b>
									
								</dt>
								<dd>Callback to be called when the user chooses the option.Two parameters are passed:<ul><li><a href="../symbols/CKFinderAPI.html">CKFinderAPI</a> CKFinder API object.</li><li><a href="../symbols/CKFinder.dataTypes.Folder.html">CKFinder.dataTypes.Folder</a> Destination folder.</li></ul></dd>
							
								<dt>
									<span class="light fixedFont">{Function}</span> <b>decisionCallback</b>
									
								</dt>
								<dd>(Optional) Callback to be called before showing the menu.One parameter is passed:<ul><li>Destination folder object <a href="../symbols/CKFinder.dataTypes.Folder.html">CKFinder.dataTypes.Folder</a></li></ul>'this' context refers to the <a href="../symbols/CKFinderAPI.html">CKFinderAPI</a> object.Accepted return values:<ul><li><code>true</code> Display item.</li><li><code>false</code> Hide item.</li></ul></dd>
							
							</dl>
						
						
						
						
						
						

					<hr />
				
					<a name="addTool"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{String}</span>
					<b>addTool</b>(markup)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Adds a tool space into the sidebar.
						
					</div>
					
					
					
						
							<pre class="code">var toolId = api.addTool( '&lt;h3>My tool&lt;/h3>&lt;p>Sample content.&lt;/p>' );// Show toolapi.showTool( toolId );</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>markup</b>
									
								</dt>
								<dd>(Optional) HTML content</dd>
							
							</dl>
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> The ID of the new DOM element.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="addToolPanel"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{String}</span>
					<b>addToolPanel</b>(markup)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Adds a tool panel into the sidebar. Tool panel features a panel layout.
						
					</div>
					
					
					
						
							<pre class="code">var toolId = api.addToolPanel( '&lt;h3>My tool&lt;/h3>&lt;p>Sample content.&lt;/p>' );// Show toolapi.showTool( toolId );</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>markup</b>
									
								</dt>
								<dd>(Optional) HTML content</dd>
							
							</dl>
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> The ID of the new DOM element.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="closePopup"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>closePopup</b>()
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0.2
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Closes a popup window containing CKFinder. It is safe to use even when CKFinder is not hosted in a popup window.
						
					</div>
					
					
					
						
							<pre class="code">var finder = new CKFinder();finder.basePath = '/ckfinder/';var api = finder.popup();// Close popup after five secondswindow.setTimeout(function() {<strong>api.closePopup();</strong>}, 5000 );</pre>
						
					
					
					
						
						
						
						
						
						

					<hr />
				
					<a name="destroy"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>destroy</b>(callback)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.1.1
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Destroys the instance.
						
					</div>
					
					
					
						
							<pre class="code">api.destroy( function(){	alert( 'The CKFinder instance was destroyed.' );} );</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Function}</span> <b>callback</b>
									
								</dt>
								<dd>(Optional) A function to be invoked after the instance is destroyed.</dd>
							
							</dl>
						
						
						
						
						
						

					<hr />
				
					<a name="disableFileContextMenuOption"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{function}</span>
					<b>disableFileContextMenuOption</b>(option, addedUsingApi)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Permanently disable specific file context menu option.
						
					</div>
					
					
					
						
							<pre class="code">// Simply call disableFileContextMenuOption to disable the menu item.api.disableFileContextMenuOption( 'viewFile', false );// If you want to enable it back later, remember in a variable an unlocking function.var enableAgain = api.disableFileContextMenuOption( 'viewFile', false );// Enabling backenableAgain();</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>option</b>
									
								</dt>
								<dd>Name of menu item.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>addedUsingApi</b>
									
								</dt>
								<dd>Boolean variable indicating whether a context menu itemwas added with <a href="../symbols/CKFinderAPI.html#addFileContextMenuOption">CKFinderAPI#addFileContextMenuOption</a> (<code>true</code>)or it is an internal CKFinder menu item (<code>false</code>).</dd>
							
							</dl>
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{function}</span> Unlocking callback function.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="disableFolderContextMenuOption"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{function}</span>
					<b>disableFolderContextMenuOption</b>(option, addedUsingApi)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Permanently disable specific folder context menu option.
						
					</div>
					
					
					
						
							<pre class="code">// Disable DisplayUrl context menu item.api.disableFolderContextMenuOption( 'DisplayUrl', true );</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>option</b>
									
								</dt>
								<dd>Name of menu item.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>addedUsingApi</b>
									
								</dt>
								<dd>Boolean variable indicating whether a context menu itemwas added with <a href="../symbols/CKFinderAPI.html#addFolderContextMenuOption">CKFinderAPI#addFolderContextMenuOption</a> (<code>true</code>)or it is an internal CKFinder menu item (<code>false</code>).</dd>
							
							</dl>
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{function}</span> Unlocking callback function.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="disableFolderDropMenuOption"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{function}</span>
					<b>disableFolderDropMenuOption</b>(option, addedUsingApi)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Permanently disable specific folder drop menu option.
						
					</div>
					
					
					
						
							<pre class="code">// Disable DisplayUrl drop menu item.api.disableFolderContextMenuOption( 'DisplayUrl', true );</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>option</b>
									
								</dt>
								<dd>Name of menu item.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>addedUsingApi</b>
									
								</dt>
								<dd>Boolean variable indicating whether a menu itemwas added with <a href="../symbols/CKFinderAPI.html#addFolderDropMenuOption">CKFinderAPI#addFolderDropMenuOption</a> (<code>true</code>)or it is an internal CKFinder menu item (<code>false</code>).</dd>
							
							</dl>
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{function}</span> Unlocking callback function.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="emptyBasket"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>emptyBasket</b>()
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Removes all files from the Basket folder (not from the filesystem folder).
						
					</div>
					
					
					
						
							<pre class="code">api.emptyBasket();</pre>
						
					
					
					
						
						
						
						
						
						

					<hr />
				
					<a name="execCommand"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>execCommand</b>(name)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						
						
					</div>
					
					
						<pre class="code"><span style="color:red">NO EXAMPLE AVAILABLE</span></pre>
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Undefined}</span> <b>name</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						

					<hr />
				
					<a name="filterFiles"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>filterFiles</b>(lookup)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Filter the displayed files according to the specified string.
						
					</div>
					
					
					
						
							<pre class="code">api.filterFiles( 'abc' );</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>lookup</b>
									
								</dt>
								<dd>The lookup string to test against. Omitting this parameter or passing null will show all files in the folder.</dd>
							
							</dl>
						
						
						
						
						
						

					<hr />
				
					<a name="getResourceType"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{<a href="../symbols/CKFinder.dataTypes.ResourceType.html">CKFinder.dataTypes.ResourceType</a>}</span>
					<b>getResourceType</b>(resourceTypeName)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Returns an object of resource type by name.
						
					</div>
					
					
					
						
							<pre class="code">alert( api.getResourceType( 'Files' ).isExtensionAllowed( 'exe' ) );</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>resourceTypeName</b>
									
								</dt>
								<dd>Name of the resource type.</dd>
							
							</dl>
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{<a href="../symbols/CKFinder.dataTypes.ResourceType.html">CKFinder.dataTypes.ResourceType</a>}</span> </dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="getSelectedFile"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{<a href="../symbols/CKFinder.dataTypes.File.html">CKFinder.dataTypes.File</a>}</span>
					<b>getSelectedFile</b>()
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Gets a selected file object.
						
					</div>
					
					
					
						
							<pre class="code">var file = api.getSelectedFile();</pre>
						
					
					
					
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{<a href="../symbols/CKFinder.dataTypes.File.html">CKFinder.dataTypes.File</a>}</span> </dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="getSelectedFiles"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Array}</span>
					<b>getSelectedFiles</b>()
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Gets an array of selected files.
						
					</div>
					
					
					
						
							<pre class="code">var files = api.getSelectedFiles();</pre>
						
					
					
					
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Array}</span> </dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="getSelectedFolder"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{<a href="../symbols/CKFinder.dataTypes.Folder.html">CKFinder.dataTypes.Folder</a>}</span>
					<b>getSelectedFolder</b>()
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Gets a selected folder object.
						
					</div>
					
					
					
						
							<pre class="code">var folder = api.getSelectedFolder();if ( folder )	alert( folder.getUrl() );</pre>
						
					
					
					
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{<a href="../symbols/CKFinder.dataTypes.Folder.html">CKFinder.dataTypes.Folder</a>}</span> </dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="hideTool"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>hideTool</b>(id)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Hides a tool panel/space by its ID.
						
					</div>
					
					
					
						
							<pre class="code">api.hideTool( toolId );</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Integer}</span> <b>id</b>
									
								</dt>
								<dd>Tool ID (returned by <a href="../symbols/CKFinderAPI.html#addTool">CKFinderAPI#addTool</a>)</dd>
							
							</dl>
						
						
						
						
						
						

					<hr />
				
					<a name="openConfirmDialog"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>openConfirmDialog</b>(title, msg, okCallback)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Opens an equivalent of a confirm() dialog window.
						
					</div>
					
					
					
						
							<pre class="code">api.openConfirmDialog( "", "Are you sure?", function( value ) {	api.openMsgDialog( "Processing", "OK, processing, please wait..." );} );</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>title</b>
									
								</dt>
								<dd>Dialog window title. If empty, the default title will be used.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>msg</b>
									
								</dt>
								<dd>Message</dd>
							
								<dt>
									<span class="light fixedFont">{Function}</span> <b>okCallback</b>
									
								</dt>
								<dd>Callback function called when a user submits the dialog window (presses the "OK" button).</dd>
							
							</dl>
						
						
						
						
						
						

					<hr />
				
					<a name="openDialog"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{<a href="../symbols/CKFinder.dialog.html">CKFinder.dialog</a>}</span>
					<b>openDialog</b>(dialogName, callback)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Loads and opens a registered dialog window.
						
					</div>
					
					
					
						
							<pre class="code">api.openDialog( 'smiley' );</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>dialogName</b>
									
								</dt>
								<dd>The registered name of the dialog window.</dd>
							
								<dt>
									<span class="light fixedFont">{Function}</span> <b>callback</b>
									
								</dt>
								<dd>(Optional) The function to be invoked after a dialog window instance is created.</dd>
							
							</dl>
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{<a href="../symbols/CKFinder.dialog.html">CKFinder.dialog</a>}</span> The dialog window object corresponding to the dialog window displayed. null if the dialog window name is not registered.</dd>
							
							</dl>
						
						
						
							<dl class="detailList">
							<dt class="heading">See:</dt>
							
								<dd><a href="../symbols/CKFinder.dialog.html#.add">CKFinder.dialog.add</a></dd>
							
							</dl>
						

					<hr />
				
					<a name="openFolder"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>openFolder</b>(resourceType, path)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Opens a directory. Note: This function will only work for folders that CKFinder is already aware of.
						
					</div>
					
					
					
						
							<pre class="code">api.open( 'Images', '/' );</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>resourceType</b>
									
								</dt>
								<dd>The name of the resource type.</dd>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>path</b>
									
								</dt>
								<dd>Path to the folder.</dd>
							
							</dl>
						
						
						
						
						
						

					<hr />
				
					<a name="openInputDialog"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>openInputDialog</b>(title, msg, value, okCallback)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Opens an equivalent of a prompt() dialog window.
						
					</div>
					
					
					
						
							<pre class="code">api.openInputDialog( "Enter number", "Enter a number: ", "0", function( value ) {	api.openMsgDialog( "", "You have entered: " + value );} );</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>title</b>
									
								</dt>
								<dd>Dialog window title. If empty, the default title will be used.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>msg</b>
									
								</dt>
								<dd>Message</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>value</b>
									
								</dt>
								<dd>Default value</dd>
							
								<dt>
									<span class="light fixedFont">{Function}</span> <b>okCallback</b>
									
								</dt>
								<dd>Callback function called when a user submits the dialog window (presses the "OK" button).Value from the dialog window text input is passed as the first argument.</dd>
							
							</dl>
						
						
						
						
						
						

					<hr />
				
					<a name="openMsgDialog"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>openMsgDialog</b>(title, msg)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Opens an equivalent of an alert() dialog window.
						
					</div>
					
					
					
						
							<pre class="code">api.openMsgDialog( "Sample title", "Sample message." );</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>title</b>
									
								</dt>
								<dd>Dialog window title. If empty, the default title will be used.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>msg</b>
									
								</dt>
								<dd>Message to display.</dd>
							
							</dl>
						
						
						
						
						
						

					<hr />
				
					<a name="openSkippedFilesDialog"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>openSkippedFilesDialog</b>(title, files, msg, okCallback)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Opens a message dialog with a list of skipped files.
						
					</div>
					
					
					
						
							<pre class="code">api.openSkippedFilesDialog( "", [ "1.jpg", "2.txt" ], "Some files could not be used." );</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>title</b>
									
								</dt>
								<dd>Dialog window title. If empty, the default title will be used.</dd>
							
								<dt>
									<span class="light fixedFont">{Array}</span> <b>files</b>
									
								</dt>
								<dd>An array of skipped files. Could be an array of strings, or array of parsed XML nodes.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>msg</b>
									
								</dt>
								<dd>Additional message to show.</dd>
							
								<dt>
									<span class="light fixedFont">{Function}</span> <b>okCallback</b>
									
								</dt>
								<dd>Callback function called when a user submits the dialog window (presses the "OK" button).</dd>
							
							</dl>
						
						
						
						
						
						

					<hr />
				
					<a name="refreshOpenedFolder"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>refreshOpenedFolder</b>()
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Refreshes the currently visible folder inside the files view.
						
					</div>
					
					
					
						
							<pre class="code">api.refreshOpenedFolder();</pre>
						
					
					
					
						
						
						
						
						
						

					<hr />
				
					<a name="removeTool"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>removeTool</b>(id)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Removes a tool panel/space by its ID.
						
					</div>
					
					
					
						
							<pre class="code">api.removeTool( toolId );</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Integer}</span> <b>id</b>
									
								</dt>
								<dd>Tool ID (returned by <a href="../symbols/CKFinderAPI.html#addTool">CKFinderAPI#addTool</a> or <a href="../symbols/CKFinderAPI.html#addToolPanel">CKFinderAPI#addToolPanel</a>)</dd>
							
							</dl>
						
						
						
						
						
						

					<hr />
				
					<a name="replaceUploadForm"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Object}</span>
					<b>replaceUploadForm</b>(html, onShow, showFocusIndicator, priority)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Replaces the default upload form with custom HTML code.To get the upload URL, call the <a href="../symbols/CKFinder.dataTypes.Folder.html#getUploadUrl">CKFinder.dataTypes.Folder#getUploadUrl</a> method.
						
					</div>
					
					
					
						
							<pre class="code">var form = api.replaceUploadForm( '&lt;div>My upload form&lt;/div>' );form.hide();</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>html</b>
									
								</dt>
								<dd>HTML code to be shown in the form panel.</dd>
							
								<dt>
									<span class="light fixedFont">{Function}</span> <b>onShow</b>
									
								</dt>
								<dd>The function to be called when the form is replaced.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>showFocusIndicator</b>
									
								</dt>
								<dd>Boolean variable indicating whether the replaced form should have asurrounding border when focused.</dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>priority</b>
									
								</dt>
								<dd>Priority of the replacement, so if there are multiple calls, only the highest one will work.</dd>
							
							</dl>
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Object}</span> Object that helps you control the upload form.Available methods:<ul><code>hide()</code> - Hides the upload form.</ul></dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="resizeFormPanel"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>resizeFormPanel</b>(height)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						
						
					</div>
					
					
						<pre class="code"><span style="color:red">NO EXAMPLE AVAILABLE</span></pre>
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Undefined}</span> <b>height</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						

					<hr />
				
					<a name="selectFile"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>selectFile</b>(fileToSelect)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						
						
					</div>
					
					
						<pre class="code"><span style="color:red">NO EXAMPLE AVAILABLE</span></pre>
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Undefined}</span> <b>fileToSelect</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						

					<hr />
				
					<a name="setUiColor"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>setUiColor</b>(string)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Sets the main color of the UI. Similar to the uiColor property of the configuration.Kama skin only.
						
					</div>
					
					
					
						
							<pre class="code">api = (new CKFinder()).create();api.setUiColor( 'white' );</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Undefined}</span> <b>string</b>
									
								</dt>
								<dd>color Color in CSS format.</dd>
							
							</dl>
						
						
						
						
						
						

					<hr />
				
					<a name="showTool"> </a>
					<div class="fixedFont" style="float:left">
					
					<span class="light">{Undefined}</span>
					<b>showTool</b>(id)
					
					</div>
					<div style="float:right">
						<span class="heading">Since:</span>
							
								2.0
							
					</div>
					<div style="clear:both"></div>
					<div class="description">
						Shows a tool panel/space by its ID.
						
					</div>
					
					
					
						
							<pre class="code">api.showTool( toolId );</pre>
						
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Integer}</span> <b>id</b>
									
								</dt>
								<dd>Tool ID (returned by <a href="../symbols/CKFinderAPI.html#addTool">CKFinderAPI#addTool</a>)</dd>
							
							</dl>
						
						
						
						
						
						

					
				
			

			<!-- ============================== event details ========================= -->		
			

			<hr />
		</div>
		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
	Copyright &copy; 2007-2015, <a href="http://cksource.com/">CKSource</a> - Frederico Knabben. All rights reserved.
</div>

	</body>
</html>
